[Connectors] Implement health check for connectors by sanjib2006 · Pull Request #3811 · intelowlproject/IntelOwl

sanjib2006 · 2026-06-26T14:20:43Z

Closes #928

Description

Health Check methods implemented for connectors

YETI - successful auth token means health check passes
Slack - slack sdk has an auth_test(), calling it validates the token and also identity info
OpenCTI - called native health_check() method of pycti
MISP - calling the misp_instance_version which connects the server instance and returns the server instance version and related info
Tests (8 tests - 2 per connector): One health check success and one health check failure (containing multiple cases as subtests) per connector

Type of change

New feature (non-breaking change which adds functionality).

Checklist

I have read and understood the rules about how to Contribute to this project
The pull request is for the branch gsoc-2026/connectors
I have added tests for the feature/bug I solved (see tests folder). All the tests (new and old ones) gave 0 errors.

…h_check

sanjib2006 · 2026-06-29T16:39:22Z

+            auth_resp = requests.post(
+                url=auth_url,
+                headers=auth_headers,
+                verify=verify_ssl,
+                timeout=10,
+            )
+            auth_resp.raise_for_status()
+            access_token = auth_resp.json().get("access_token")
+


For yeti:
I am checking a post request to get the access token, if the server responsds a valid token then the health check passes.

Check this

Screenshots of the logs of various variations for YETI:

failed due to invalid url

invalid api key

video

2026-06-29.22-16-44.mp4

All tests(including two health check tests) are passing

same here ,a comment in the code about your decision of using the access token and why, just like you did in this github comment

sanjib2006 · 2026-06-29T17:05:44Z

+        try:
+            client = slack_sdk.WebClient(token=token)
+            client.auth_test()
+            return True


Slack:

this tests if the token is valid by doing an authentication test + returns identity info (discarded that info)

we had two more params (channel and slack_username) channel just wants a valid channel name on the slack channel and slack_username could be anything (this is just added to the info we send to slack). So I have not added these two to the test + auth_test() requires only the token

Official docs here

Logs:

invalid api

missing token

video:

2026-06-29.22-38-04.mp4

tests:

I have added only the health check tests for now. I will add other tests for slack later.

same here, add a comment please

sanjib2006 · 2026-06-29T17:21:05Z

+        try:
+            client = pycti.OpenCTIApiClient(url, token, ssl_verify=ssl_verify, proxies=proxies)
+            resp = client.health_check()
+            return resp


OpenCTI:

pycti does have a health_check(), so just created a client and called that method

docs

Logs:

missing url

invalid api_key

video:

2026-06-29.22-59-30.mp4

tests:

thanks for showing the demo. Very helpful. Is there any chance to modify the toast shown to the user to explain which is the issue? Otherwise it would be difficult for an user to understand the cause. Admins have logs but a classic user can't see them.
That would be a very good addition for all the cases

also here, please add a comment and a link about what you explained regarding the health check

thanks for showing the demo. Very helpful. Is there any chance to modify the toast shown to the user to explain which is the issue? Otherwise it would be difficult for an user to understand the cause. Admins have logs but a classic user can't see them. That would be a very good addition for all the cases

yaa I was also thinking about this while doing it that it would better if the cause was visible in the ui itself, I will check and let you know

sanjib2006 · 2026-06-29T18:25:25Z

+        try:
+            misp = pymisp.PyMISP(
+                url=url,
+                key=key,
+                ssl=ssl_param,
+                debug=False,
+                timeout=5,
+            )
+
+            misp.misp_instance_version
+            return True
+
+        except Exception as e:
+            logger.info(f"MISP health check failed: {e}")
+            return False


MISP:

misp_instance_version returns the server's (MISP instance) version, so it does make a request to the server and also checks the validity of the api key

docs

logs:
missing url

invalid api key

video:
https://github.com/user-attachments/assets/ba622624-eb47-4e9d-9a13-6aedccf6bc14

tests:

can you add the information about misp_instance_version as a comment? Otherwise that info would be lost for future maintainers.

sanjib2006 · 2026-06-29T18:45:46Z

Hi @mlodic please have a look at this.

Email sender/abuse submitter do not use config url/api key or remote instances so I have not done anything for them.

If changes are required then do let me know.

Thanks!

mlodic

good work, added some comments

mlodic · 2026-06-30T04:31:45Z

+        try:
+            client = pycti.OpenCTIApiClient(url, token, ssl_verify=ssl_verify, proxies=proxies)
+            resp = client.health_check()
+            return resp


thanks for showing the demo. Very helpful. Is there any chance to modify the toast shown to the user to explain which is the issue? Otherwise it would be difficult for an user to understand the cause. Admins have logs but a classic user can't see them.
That would be a very good addition for all the cases

mlodic · 2026-06-30T04:34:58Z

+        try:
+            misp = pymisp.PyMISP(
+                url=url,
+                key=key,
+                ssl=ssl_param,
+                debug=False,
+                timeout=5,
+            )
+
+            misp.misp_instance_version
+            return True
+
+        except Exception as e:
+            logger.info(f"MISP health check failed: {e}")
+            return False


can you add the information about misp_instance_version as a comment? Otherwise that info would be lost for future maintainers.

mlodic · 2026-06-30T04:35:37Z

+        try:
+            client = pycti.OpenCTIApiClient(url, token, ssl_verify=ssl_verify, proxies=proxies)
+            resp = client.health_check()
+            return resp


also here, please add a comment and a link about what you explained regarding the health check

mlodic · 2026-06-30T04:35:58Z

+        try:
+            client = slack_sdk.WebClient(token=token)
+            client.auth_test()
+            return True


same here, add a comment please

mlodic · 2026-06-30T04:37:10Z

+            auth_resp = requests.post(
+                url=auth_url,
+                headers=auth_headers,
+                verify=verify_ssl,
+                timeout=10,
+            )
+            auth_resp.raise_for_status()
+            access_token = auth_resp.json().get("access_token")
+


same here ,a comment in the code about your decision of using the access token and why, just like you did in this github comment

sanjib2006 · 2026-06-30T05:04:51Z

I will add the comments as you said and then this PR can be closed.

For the failure messages, we have to do slight changes in the backend, health_check methods and the frontend files.
Those are designed to return only status(true/false). We can update it to a message with the status.
I plan to do this by creating a new issue after completing this PR.

Thanks for the review 🙌

mlodic · 2026-06-30T05:18:25Z

thanks to you for the work, looking forward the next improvements.

… and YETI connectors

sanjib2006 · 2026-06-30T05:41:09Z

Hey @mlodic, I have added the comments.
Should I add the reference docs/url in the comments also?

mlodic · 2026-06-30T05:58:17Z

yep if possible yes so we can track possible changes in the future

…P, OpenCTI, Slack, and YETI connectors

sanjib2006 · 2026-06-30T06:17:55Z

@mlodic Done 🔥
I have added the official reference links as comments.

sanjib2006 added 5 commits June 26, 2026 19:46

feat(yeti): implement health check

7884203

test(yeti): add health check tests for YETI connector

eea1f92

test(yeti): fix deepsource errors

ac66a5f

feat(slack): add health check for slack

d29f263

feat(slack): add health check tests for Slack connector

f04ebe1

sanjib2006 linked an issue Jun 26, 2026 that may be closed by this pull request

make Connectors Health Checks more reliable #928

Closed

sanjib2006 added 5 commits June 27, 2026 20:27

feat(opencti): implement health check method for OpenCTI connector

872a67b

test(opencti): add health check tests for OpenCTI connector

264f643

feat(opencti): add ssl_verify and proxies parameters to OpenCTI healt…

a935c85

…h_check

feat(misp): implement health check method for MISP connector

30997d7

test(misp): add health check tests for MISP connector

b33167f

sanjib2006 commented Jun 29, 2026

View reviewed changes

sanjib2006 marked this pull request as ready for review June 29, 2026 18:40

mlodic reviewed Jun 30, 2026

View reviewed changes

feat(connectors): add health check comments for MISP, OpenCTI, Slack,…

7a58ed2

… and YETI connectors

feat(connectors): add reference links for health check methods in MIS…

f769a75

…P, OpenCTI, Slack, and YETI connectors

mlodic approved these changes Jun 30, 2026

View reviewed changes

mlodic merged commit 68694fb into gsoc-2026/connectors Jun 30, 2026
3 checks passed

sanjib2006 deleted the gsoc-2026/feat-connectors-health-check branch July 1, 2026 12:18

Uh oh!

Uh oh!

Conversation

sanjib2006 commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Health Check methods implemented for connectors

Type of change

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sanjib2006 Jun 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sanjib2006 commented Jun 29, 2026

Uh oh!

mlodic left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sanjib2006 commented Jun 30, 2026

Uh oh!

mlodic commented Jun 30, 2026

Uh oh!

sanjib2006 commented Jun 30, 2026

Uh oh!

mlodic commented Jun 30, 2026

Uh oh!

sanjib2006 commented Jun 30, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sanjib2006 commented Jun 26, 2026 •

edited

Loading

sanjib2006 Jun 29, 2026 •

edited

Loading